EstuaryClient.AutoretrieveApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
adminAutoretrieveInitPost	POST /admin/autoretrieve/init	Register autoretrieve server
adminAutoretrieveListGet	GET /admin/autoretrieve/list	List autoretrieve servers
autoretrieveHeartbeatPost	POST /autoretrieve/heartbeat	Marks autoretrieve server as up

adminAutoretrieveInitPost

'String' adminAutoretrieveInitPost(addresses, pubKey)

Register autoretrieve server

This endpoint registers a new autoretrieve server

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.AutoretrieveApi();
let addresses = "addresses_example"; // String | 
let pubKey = "pubKey_example"; // String | 

apiInstance.adminAutoretrieveInitPost(addresses, pubKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
addresses	String
pubKey	String

Return type

'String'

Authorization

bearerAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

adminAutoretrieveListGet

'String' adminAutoretrieveListGet()

List autoretrieve servers

This endpoint lists all registered autoretrieve servers

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.AutoretrieveApi();
apiInstance.adminAutoretrieveListGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

autoretrieveHeartbeatPost

'String' autoretrieveHeartbeatPost(token)

Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.AutoretrieveApi();
let token = "token_example"; // String | Autoretrieve's auth token

apiInstance.autoretrieveHeartbeatPost(token, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
token	String	Autoretrieve's auth token

Return type

'String'

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json